﻿/*******************************************************************************************
 * Copyright (c) 2009 Alex Robson, Rob Simmons, Craig Israel, and Rachel Twyford
 *
 * Use of this software in any form requires that you have both 
 * read and agreed to the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions: 
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution.
 * Neither the name of Nvigorate nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************************/

using System;
using System.Xml.Linq;
using Nvigorate.Common.Reflection;
using Nvigorate.Relational.Mapping.Interface;

namespace Nvigorate.Relational.Mapping
{
    [Serializable]
    public abstract class BaseRelationship : ITargetRelationship
    {
        protected Relationship _relationship;

        protected string _relative;

        protected string _relativeProperty;

        protected Type _relativeType;

        protected string _subject;

        protected Type _subjectType;

        /// <summary>
        /// Describes the nature of the relationship from the
        /// perspective of the subject
        /// </summary>
        public Relationship Relationship
        {
            get { return _relationship; }
            set { _relationship = value; }
        }

        /// <summary>
        /// The name of the relative
        /// </summary>
        public string Relative
        {
            get
            {
                _relative = _relative ?? _relativeType.FullName;
                return _relative;
            }
            set { _relative = value; }
        }

        /// <summary>
        /// The name of the property in which the
        /// relative is stored
        /// </summary>
        public string RelativeProperty
        {
            get { return _relativeProperty; }
            set { _relativeProperty = value; }
        }

        /// <summary>
        /// The name of the relative type
        /// </summary>
        public Type RelativeType
        {
            get
            {
                _relativeType = _relativeType ?? Reflector.GetType(_relative);
                return _relativeType;
            }
            set { _relativeType = value; }
        }

        /// <summary>
        /// The name of the subject
        /// </summary>
        public string Subject
        {
            get
            {
                _subject = _subject ?? _subjectType.FullName;
                return _subject;
            }
            set { _subject = value; }
        }

        /// <summary>
        /// The name of the subject type
        /// </summary>
        public Type SubjectType
        {
            get
            {
                _subjectType = _subjectType ?? Reflector.GetType(_subject);
                return _subjectType;
            }
            set { _subjectType = value; }
        }

        public abstract bool IsInverse(ITargetRelationship relationship);

        #region ILinqToXml

        public abstract XElement GetXElementRepresentation();

        public abstract object ParseXElement(XElement element);

        #endregion
    }
}